/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License"),
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup TeeTrusted
 * @{
 *
 * @brief TEE（Trusted Excution Environment）可信执行环境API。
 *
 * 提供安全能力API，例如可信存储、加解密及可信时间等，用于可信应用程序开发。
 *
 * @since 20
 */

/**
 * @file tee_get_recoverymode.h
 *
 * @brief 提供用于获取系统启动模式的相关接口函数。
 *
 * @library NA
 * @kit TEEKit
 * @include <TEEKit/tee_get_recoverymode.h>
 * @syscap SystemCapability.Tee.TeeClient
 * @since 20
 */

#ifndef TEE_GET_RECOVERYMODE_H
#define TEE_GET_RECOVERYMODE_H

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 枚举系统支持的启动模式。
 *
 * @since 20
 */
typedef enum {
    /** 系统处于关机或正在关机状态。 */
    BOOT_MODE_SHUTDOWN = 0,
    /** 正常启动模式。 */
    BOOT_MODE_NORMAL,
    /** Fastboot启动模式。 */
    BOOT_MODE_FASTBOOT,
    /** 恢复模式。 */
    BOOT_MODE_RECOVERY,
    /** eRecovery模式。 */
    BOOT_MODE_RECOVERY2,
    /** 支持的启动模式数量上限。 */
    BOOT_MODE_CNT_MAX
} boot_modes;

/**
 * @brief 获取当前启动模式。
 *
 * @param recoverymode [OUT]表示当前启动模式。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         TEE_ERROR_BAD_PARAMETERS：表示输入参数错误。
 * @since 20
 */
int32_t tee_ext_get_recoverymode(enum boot_modes *recoverymode);

#ifdef __cplusplus
}
#endif

#endif
/** @} */